DeferredUnion

Flow-native helpers for one-shot typed coordination.

Specification

Kind
Union
Members
12
Examples
0
makeSignature
Deferred.make ()
awaitSignature
Deferred.await deferred
completeNowSignature
Deferred.completeNow exit deferred
succeedNowSignature
Deferred.succeedNow value deferred
failNowSignature
Deferred.failNow error deferred

Summary

NameSignatureSynopsis
Operations
makeDeferred.make ()Creates an empty deferred value.
awaitDeferred.await deferredWaits for the deferred outcome, preserving success, typed failure, defect, or interruption.
completeNowDeferred.completeNow exit deferredTries to complete a deferred directly from a synchronous callback.
succeedNowDeferred.succeedNow value deferredTries to complete a deferred successfully from a synchronous callback.
failNowDeferred.failNow error deferredTries to complete a deferred with a typed failure from a synchronous callback.
dieNowDeferred.dieNow error deferredTries to complete a deferred with a defect from a synchronous callback.
interruptNowDeferred.interruptNow deferredTries to complete a deferred as interrupted from a synchronous callback.
completeDeferred.complete exit deferredAttempts to complete the deferred value with a full outcome.
succeedDeferred.succeed value deferredAttempts to complete the deferred value successfully.
failDeferred.fail error deferredAttempts to complete the deferred value with a typed failure.
dieDeferred.die error deferredAttempts to complete the deferred value with a defect.
interruptDeferred.interrupt deferredAttempts to complete the deferred value as interrupted.

Operations

kind:member

make

Deferred.make ()
Member
Creates an empty deferred value.

Parameters

NameTypeDescription
unit

Returns

Flow<'env, 'error, Deferred<'error, 'value>>
kind:member

await

Deferred.await deferred
Member
Waits for the deferred outcome, preserving success, typed failure, defect, or interruption.

Parameters

NameTypeDescription
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'error, 'value>
kind:member

completeNow

Deferred.completeNow exit deferred
Member
Tries to complete a deferred directly from a synchronous callback.

Parameters

NameTypeDescription
exitExit<'value, 'error>
deferredDeferred<'error, 'value>

Returns

bool
kind:member

succeedNow

Deferred.succeedNow value deferred
Member
Tries to complete a deferred successfully from a synchronous callback.

Parameters

NameTypeDescription
value'value
deferredDeferred<'error, 'value>

Returns

bool
kind:member

failNow

Deferred.failNow error deferred
Member
Tries to complete a deferred with a typed failure from a synchronous callback.

Parameters

NameTypeDescription
error'error
deferredDeferred<'error, 'value>

Returns

bool
kind:member

dieNow

Deferred.dieNow error deferred
Member
Tries to complete a deferred with a defect from a synchronous callback.

Parameters

NameTypeDescription
errorexn
deferredDeferred<'error, 'value>

Returns

bool
kind:member

interruptNow

Deferred.interruptNow deferred
Member
Tries to complete a deferred as interrupted from a synchronous callback.

Parameters

NameTypeDescription
deferredDeferred<'error, 'value>

Returns

bool
kind:member

complete

Deferred.complete exit deferred
Member
Attempts to complete the deferred value with a full outcome.

Parameters

NameTypeDescription
exitExit<'value, 'error>
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

succeed

Deferred.succeed value deferred
Member
Attempts to complete the deferred value successfully.

Parameters

NameTypeDescription
value'value
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

fail

Deferred.fail error deferred
Member
Attempts to complete the deferred value with a typed failure.

Parameters

NameTypeDescription
error'error
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

die

Deferred.die error deferred
Member
Attempts to complete the deferred value with a defect.

Parameters

NameTypeDescription
errorexn
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>
kind:member

interrupt

Deferred.interrupt deferred
Member
Attempts to complete the deferred value as interrupted.

Parameters

NameTypeDescription
deferredDeferred<'error, 'value>

Returns

Flow<'env, 'workflowError, bool>